home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / SCGetSaveOptions.z / SCGetSaveOptions
Encoding:
Text File  |  1998-10-30  |  5.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSCCCCGGGGEEEETTTTSSSSAAAAVVVVEEEEOOOOPPPPTTTTIIIIOOOONNNNSSSS((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSCCCCGGGGEEEETTTTSSSSAAAAVVVVEEEEOOOOPPPPTTTTIIIIOOOONNNNSSSS((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SCGetSaveOptions, SCSetSaveOptions - Getting and setting saved scanner
  10.      specific options
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssttttddddiiiioooo....hhhh>>>>
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccaaaannnnnnnneeeerrrr....hhhh>>>>
  15.  
  16.      iiiinnnntttt SSSSCCCCGGGGeeeettttSSSSaaaavvvveeeeOOOOppppttttiiiioooonnnnssss((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss,,,, vvvvooooiiiidddd ********ooooppppttttiiiioooonnnnssss,,,, iiiinnnntttt ****nnnnBBBByyyytttteeeessss))));;;;
  17.  
  18.      iiiinnnntttt SSSSCCCCSSSSeeeettttSSSSaaaavvvveeeeOOOOppppttttiiiioooonnnnssss((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss,,,, vvvvooooiiiidddd ****ooooppppttttiiiioooonnnnssss,,,, iiiinnnntttt nnnnBBBByyyytttteeeessss))));;;;
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s and _S_C_S_e_t_S_a_v_e_O_p_t_i_o_n_s exist as a mechanism for scanner
  22.      applications to save scanner specific settings for later restoration.
  23.      _g_s_c_a_n(1) uses these functions to save scanner specific settings when you
  24.      choose "Save Current Settings..." from the "Setup" menu.
  25.  
  26.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s retrieves a sequence of bytes which when passed back to
  27.      the scanner driver via a subsequent call to _S_C_S_e_t_S_a_v_e_O_p_t_i_o_n_s restores the
  28.      scanner specific settings for _s to what the were at the time that
  29.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s was called.
  30.  
  31.      For both functions, _s is a SSSSCCCCAAAANNNNNNNNEEEERRRR pointer returned by a call to
  32.      _S_C_O_p_e_n(3), _S_C_O_p_e_n_F_i_l_e(3), or _S_C_O_p_e_n_S_c_r_e_e_n(3).
  33.  
  34.      After _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s returns successfully, *_o_p_t_i_o_n_s will point to
  35.      *_n_B_y_t_e_s bytes worth of scanner specific options settings.  The layout of
  36.      this memory is completely at the discretion of the scanner driver and
  37.      should not be interpreted in any way by the scanner application.  The
  38.      only thing the application should do with this memory is save it to a
  39.      permanent location for later restoration.  The memory pointed to by
  40.      *_o_p_t_i_o_n_s is owned by _l_i_b_s_c_a_n(3) and should not be modified or freed, and
  41.      should not be expected to maintain its contents across subsequent calls
  42.      to _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s.
  43.  
  44.      For _S_C_S_e_t_S_a_v_e_O_p_t_i_o_n_s, _o_p_t_i_o_n_s is a pointer to _n_B_y_t_e_s of memory which will
  45.      be transmitted to the scanner driver as scanner specific options
  46.      settings.  The only valid way for a scanner application to have obtained
  47.      data for passing to _S_C_S_e_t_S_a_v_e_O_p_t_i_o_n_s is to have previously called
  48.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s and saved the results.
  49.  
  50. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  51.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s and _S_C_S_e_t_S_a_v_e_O_p_t_i_o_n_s return 0 if successful, and -1 if
  52.      an error occurs.  In the event of an error, _S_C_e_r_r_n_o will be set to
  53.      indicate the cause of the error.
  54.  
  55. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  56.      SCENOSAVEOPT             No scanner specific savable options
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSCCCCGGGGEEEETTTTSSSSAAAAVVVVEEEEOOOOPPPPTTTTIIIIOOOONNNNSSSS((((3333))))              IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo               SSSSCCCCGGGGEEEETTTTSSSSAAAAVVVVEEEEOOOOPPPPTTTTIIIIOOOONNNNSSSS((((3333))))
  71.  
  72.  
  73.  
  74.      SCENOMEM                 Out of memory
  75.  
  76.      SCECOMM                  Error communicating with scanner driver
  77.  
  78. WWWWAAAARRRRNNNNIIIINNNNGGGG
  79.      The pointer obtained by calling _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s points to memory owned
  80.      by _l_i_b_s_c_a_n(3).  The calling program should not modify the memory pointed
  81.      to by the return value of _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s, nor should any assumptions be
  82.      made about its value after subsequent calls to _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s. Any
  83.      needed information should be copied into program memory before calling
  84.      _S_C_G_e_t_S_a_v_e_O_p_t_i_o_n_s again.
  85.  
  86. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  87.      _l_i_b_s_c_a_n(3).
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.